Allow custom localize function for datatable #21270

bramkragten · 2024-07-03T15:09:37Z

Proposed change

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

New Features
- Enhanced localization flexibility for data tables with a new localizeFunc property.
- Improved localization handling in HaTabsSubpageDataTable by passing a localize property.

coderabbitai · 2024-07-03T15:09:45Z

Walkthrough

The overall change introduces a more flexible localization handling mechanism within the HaDataTable and HaTabsSubpageDataTable components. Instead of strictly relying on this.hass.localize, a new localizeFunc property is added, allowing these components to accept and use an external localization function if provided. This adjustment enhances adaptability to various localization requirements.

Changes

File	Change Summary
`src/components/data-table/ha-data-table.ts`	Introduced `localizeFunc` property and updated rendering logic to utilize it or fall back on `this.hass.localize`.
`src/layouts/hass-tabs-subpage-data-table.ts`	Passed `localize` to `ha-data-table` component and updated button text binding.

Sequence Diagram(s)

sequenceDiagram
    participant ComponentA
    participant HaDataTable
    participant HaTabsSubpageDataTable

    ComponentA->>HaTabsSubpageDataTable: Construct with localize function
    HaTabsSubpageDataTable->>HaDataTable: Pass localize function in props
    HaDataTable->>HaDataTable: Choose localize function based on props
    HaDataTable->>HaTabsSubpageDataTable: Localize data for display
    HaTabsSubpageDataTable-->>ComponentA: Render localized data

Tip

AI model upgrade

`gpt-4o` model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 97c4cf9 and 790d43b.

Files selected for processing (2)

src/components/data-table/ha-data-table.ts (6 hunks)
src/layouts/hass-tabs-subpage-data-table.ts (2 hunks)

Additional comments not posted (5)

src/layouts/hass-tabs-subpage-data-table.ts (1)
433-433: Verify the usage of the localizeFunc property.

Ensure that the localizeFunc property is correctly passed and utilized in the ha-data-table component.

Verification successful

The localizeFunc property is correctly utilized in the ha-data-table component.

The property is declared and passed as expected, ensuring proper functionality.

src/layouts/hass-tabs-subpage-data-table.ts

src/components/data-table/ha-data-table.ts
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type typescript $'localizeFunc'
Length of output: 70

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg 'localizeFunc' --glob '*.ts'
Length of output: 1455
src/components/data-table/ha-data-table.ts (4)
114-115: Verify the usage of the localizeFunc property.

Ensure that the localizeFunc property is correctly utilized in the ha-data-table component.

Verification successful

The localizeFunc property is correctly utilized in the ha-data-table component.

The property is declared and used to determine the localization function, falling back to this.hass.localize if localizeFunc is not defined.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type typescript $'localizeFunc'
Length of output: 70

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --glob '*.ts' 'localizeFunc'
Length of output: 1455
444-444: Verify the usage of the localizeFunc property.

Ensure that the localizeFunc property is correctly utilized in the render function.

Verification successful

The localizeFunc property is correctly utilized in the ha-data-table component.

The property is declared and used appropriately within the file.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type typescript $'localizeFunc'
Length of output: 70

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type ts 'localizeFunc'
Length of output: 1451
323-324: Verify the usage of the localizeFunc property.

Ensure that the localizeFunc property is correctly utilized in the render function.

Verification successful

The localizeFunc property is correctly utilized in the ha-data-table component.

src/components/data-table/ha-data-table.ts: The property is defined and used appropriately.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type typescript $'localizeFunc'
Length of output: 70

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type ts 'localizeFunc'
Length of output: 1451
627-628: Verify the usage of the localizeFunc property.

Ensure that the localizeFunc property is correctly utilized in the render function.

Verification successful

The localizeFunc property is correctly utilized in the ha-data-table component.

src/components/data-table/ha-data-table.ts: The localizeFunc property is defined and used in the render function as expected.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type typescript $'localizeFunc'
Length of output: 70

Script:
#!/bin/bash
# Description: Verify the usage of the `localizeFunc` property in the `ha-data-table` component.

# Test: Search for the `localizeFunc` property in the `ha-data-table` component. Expect: Correct usage of the new property.
rg --type ts 'localizeFunc'
Length of output: 1451

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Allow custom localize function for datatable

790d43b

home-assistant bot added the cla-signed label Jul 3, 2024

piitaya approved these changes Jul 4, 2024

View reviewed changes

silamon merged commit df7b5b0 into dev Jul 4, 2024
14 checks passed

silamon deleted the localize-function-datatable branch July 4, 2024 09:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow custom localize function for datatable #21270

Allow custom localize function for datatable #21270

bramkragten commented Jul 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 3, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

`gpt-4o` model for reviews and chat is now live

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Allow custom localize function for datatable #21270

Allow custom localize function for datatable #21270

Conversation

bramkragten commented Jul 3, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jul 3, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

gpt-4o model for reviews and chat is now live

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

bramkragten commented Jul 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 3, 2024 •

edited

Loading

`gpt-4o` model for reviews and chat is now live

CodeRabbit Configration File (`.coderabbit.yaml`)